<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Pod::Coverage - Checks if the documentation of a module is comprehensive - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Pod-Coverage - MetaCPAN" href="https://metacpan.org/dist/Pod-Coverage/releases.rss" />
        <link rel="canonical" href="./Pod::Coverage.html" />
        <meta name="description" content="Checks if the documentation of a module is comprehensive" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Pod::Coverage" />
<meta name="twitter:title"       content="Pod::Coverage" />
<meta name="twitter:description" content="Checks if the documentation of a module is comprehensive" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Pod::Coverage.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Pod-Coverage was released.">
      <span class="relatize">01 May 2013 13:14:58 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Pod-Coverage">Pod-Coverage</a>
  </li>
  <li>
    Module version: 0.23
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Pod-Coverage/source/lib/Pod/Coverage.pm">Source</a>
    (<a href="https://metacpan.org/dist/Pod-Coverage/source/lib/Pod/Coverage.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Pod-Coverage/source/lib/Pod">Browse</a>
    (<a href="https://metacpan.org/dist/Pod-Coverage/source/lib/Pod?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Pod-Coverage/changes">Changes</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Pod-Coverage/contribute">How to Contribute</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Coverage">Issues</a>
      (18)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Pod-Coverage+0.23" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Coverage.html?oncpan=1&amp;distmat=1&amp;version=0.23&amp;grade=2" style="color: #090">1472</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Coverage.html?oncpan=1&amp;distmat=1&amp;version=0.23&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Coverage.html?oncpan=1&amp;distmat=1&amp;version=0.23&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/RCLAMP/Pod-Coverage-0.23">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Pod-Coverage who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 1
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Pod-Coverage-0.23/index.html">14.53% Coverage </a>
    </li>
    <li>
      License: unknown
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Pod-Coverage/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/R/RC/RCLAMP/Pod-Coverage-0.23.tar.gz">
      Download (<span itemprop="fileSize">12.9KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FRCLAMP%2FPod-Coverage-0.23%2Flib%2FPod%2FCoverage.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-Coverage/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-Coverage/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Pod-Coverage">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Pod-Coverage">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/Coverage.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="RCLAMP/Pod-Coverage-0.23"
>0.23
  (RCLAMP on 2013-05-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.22"
>0.22
  (RCLAMP on 2012-02-07)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.21"
>0.21
  (RCLAMP on 2010-07-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.20"
>0.20
  (RCLAMP on 2009-02-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.19"
>0.19
  (RCLAMP on 2007-09-13)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.18"
>0.18
  (RCLAMP on 2006-08-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.17"
>0.17
  (RCLAMP on 2004-11-23)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.16"
>0.16
  (RCLAMP on 2004-10-20)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.15"
>0.15
  (RCLAMP on 2004-10-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.14"
>0.14
  (RCLAMP on 2004-05-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="RCLAMP/Pod-Coverage-0.13"
>0.13
  (RCLAMP on 2003-12-29)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.12"
>0.12
  (RCLAMP on 2003-09-30)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.11"
>0.11
  (RCLAMP on 2002-02-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.10"
>0.10
  (RCLAMP on 2002-02-18)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.09"
>0.09
  (RCLAMP on 2001-12-17)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.08"
>0.08
  (RCLAMP on 2001-11-14)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.07"
>0.07
  (RCLAMP on 2001-09-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.06"
>0.06
  (RCLAMP on 2001-09-02)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.05"
>0.05
  (RCLAMP on 2001-09-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.04"
>0.04
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.03"
>0.03
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.02"
>0.02
  (RCLAMP on 2001-08-27)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/RCLAMP/Pod-Coverage-0.23/diff/' + encodeURIComponent(this.value) + '/lib/Pod/Coverage.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="RCLAMP/Pod-Coverage-0.23"
>0.23
  (RCLAMP on 2013-05-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.22"
>0.22
  (RCLAMP on 2012-02-07)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.21"
>0.21
  (RCLAMP on 2010-07-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.20"
>0.20
  (RCLAMP on 2009-02-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.19"
>0.19
  (RCLAMP on 2007-09-13)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.18"
>0.18
  (RCLAMP on 2006-08-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.17"
>0.17
  (RCLAMP on 2004-11-23)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.16"
>0.16
  (RCLAMP on 2004-10-20)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.15"
>0.15
  (RCLAMP on 2004-10-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.14"
>0.14
  (RCLAMP on 2004-05-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="RCLAMP/Pod-Coverage-0.13"
>0.13
  (RCLAMP on 2003-12-29)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.12"
>0.12
  (RCLAMP on 2003-09-30)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.11"
>0.11
  (RCLAMP on 2002-02-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.10"
>0.10
  (RCLAMP on 2002-02-18)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.09"
>0.09
  (RCLAMP on 2001-12-17)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.08"
>0.08
  (RCLAMP on 2001-11-14)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.07"
>0.07
  (RCLAMP on 2001-09-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.06"
>0.06
  (RCLAMP on 2001-09-02)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.05"
>0.05
  (RCLAMP on 2001-09-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.04"
>0.04
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.03"
>0.03
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.02"
>0.02
  (RCLAMP on 2001-08-27)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="https://metacpan.org/pod/Devel::Symdump" title="Devel::Symdump" class="ellipsis">Devel::Symdump</a></li>
  <li><a href="./Pod::Find.html" title="Pod::Find" class="ellipsis">Pod::Find</a></li>
  <li><a href="./Pod::Parser.html" title="Pod::Parser" class="ellipsis">Pod::Parser</a></li>
  <li><a href="https://metacpan.org/pod/Test::More" title="Test::More" class="ellipsis">Test::More</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Pod::Coverage/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Pod%3A%3ACoverage">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Pod-Coverage">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/RCLAMP/Pod-Coverage-0.23/view/lib/Pod/Coverage.pm">This version</a>
    </li>
    <li>
      <a href="./Pod::Coverage.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/DOHERTY"><img src="https://www.gravatar.com/avatar/9533c36b6385c8321bad636c98e9c0a8?d=identicon&amp;s=20" title="DOHERTY" alt="DOHERTY"></a>
<a class="display-all" href="https://metacpan.org/author/SYP"><img src="https://www.gravatar.com/avatar/9b6fa62677be03c25ee1af4d95472042?d=identicon&amp;s=20" title="SYP" alt="SYP"></a>
<a class="display-all" href="https://metacpan.org/author/KRAUTCAT"><img src="https://www.gravatar.com/avatar/efd137d1577aa9df7fc833f6306958d5?d=identicon&amp;s=20" title="KRAUTCAT" alt="KRAUTCAT"></a>
<a class="display-all" href="https://metacpan.org/author/ARJONES"><img src="https://www.gravatar.com/avatar/779fdd029141571e2650d9060978c1a1?d=identicon&amp;s=20" title="ARJONES" alt="ARJONES"></a>
<a class="display-all" href="https://metacpan.org/author/JMATES"><img src="https://www.gravatar.com/avatar/06accb84e6519284be3941ff72e429cb?d=identicon&amp;s=20" title="JMATES" alt="JMATES"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/Pod-Coverage/plussers">7 PAUSE users</a>
</div>
<div>
    5 non-PAUSE users
</div>
</div>
    </li>
    <li>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/RCLAMP" class="author-name">Richard Clamp</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/Coverage.pm&#39;" class="">
<option
  selected
  value="RCLAMP/Pod-Coverage-0.23"
>0.23
  (RCLAMP on 2013-05-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.22"
>0.22
  (RCLAMP on 2012-02-07)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.21"
>0.21
  (RCLAMP on 2010-07-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.20"
>0.20
  (RCLAMP on 2009-02-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.19"
>0.19
  (RCLAMP on 2007-09-13)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.18"
>0.18
  (RCLAMP on 2006-08-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.17"
>0.17
  (RCLAMP on 2004-11-23)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.16"
>0.16
  (RCLAMP on 2004-10-20)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.15"
>0.15
  (RCLAMP on 2004-10-19)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.14"
>0.14
  (RCLAMP on 2004-05-09)</option>
<optgroup label="BackPAN">'
<option
  
  value="RCLAMP/Pod-Coverage-0.13"
>0.13
  (RCLAMP on 2003-12-29)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.12"
>0.12
  (RCLAMP on 2003-09-30)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.11"
>0.11
  (RCLAMP on 2002-02-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.10"
>0.10
  (RCLAMP on 2002-02-18)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.09"
>0.09
  (RCLAMP on 2001-12-17)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.08"
>0.08
  (RCLAMP on 2001-11-14)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.07"
>0.07
  (RCLAMP on 2001-09-04)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.06"
>0.06
  (RCLAMP on 2001-09-02)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.05"
>0.05
  (RCLAMP on 2001-09-01)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.04"
>0.04
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.03"
>0.03
  (RCLAMP on 2001-08-27)</option>
<option
  
  value="RCLAMP/Pod-Coverage-0.02"
>0.02
  (RCLAMP on 2001-08-27)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Pod-Coverage">Pod-Coverage-0.23</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage three &#10;
          • 65 direct dependents &#10;          • 872 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Pod-Coverage-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Pod-Coverage-0.23">
    <input type="hidden" name="author" value="RCLAMP">
    <input type="hidden" name="distribution" value="Pod-Coverage">
    <button type="submit" class="favorite highlight"><span>12</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Pod::Coverage.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>12</span> ++</a>
</div>
   / <span>Pod::Coverage</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Pod::Coverage.html#NAME">NAME</a></li>
  <li><a href="./Pod::Coverage.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Pod::Coverage.html#DESCRIPTION">DESCRIPTION</a>
    <ul>
      <li><a href="./Pod::Coverage.html#Methods">Methods</a></li>
      <li><a href="./Pod::Coverage.html#Debugging-support">Debugging support</a></li>
      <li><a href="./Pod::Coverage.html#Inheritance-interface">Inheritance interface</a></li>
    </ul>
  </li>
  <li><a href="./Pod::Coverage.html#BUGS">BUGS</a></li>
  <li><a href="./Pod::Coverage.html#TODO">TODO</a></li>
  <li><a href="./Pod::Coverage.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Pod::Coverage.html#AUTHORS">AUTHORS</a></li>
  <li><a href="./Pod::Coverage.html#COPYRIGHT">COPYRIGHT</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Pod::Coverage - Checks if the documentation of a module is comprehensive</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  # in the beginnning...
  perl -MPod::Coverage=Pod::Coverage -e666

  # all in one invocation
  use Pod::Coverage package =&gt; &#39;Fishy&#39;;

  # straight OO
  use Pod::Coverage;
  my $pc = Pod::Coverage-&gt;new(package =&gt; &#39;Pod::Coverage&#39;);
  print &quot;We rock!&quot; if $pc-&gt;coverage == 1;</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>Developers hate writing documentation. They&#39;d hate it even more if their computer tattled on them, but maybe they&#39;ll be even more thankful in the long run. Even if not, <i>perlmodstyle</i> tells you to, so you must obey.</p>

<p>This module provides a mechanism for determining if the pod for a given module is comprehensive.</p>

<p>It expects to find either a <code>=head(n&gt;1)</code> or an <code>=item</code> block documenting a subroutine.</p>

<p>Consider: # an imaginary Foo.pm package Foo;</p>

<pre><code> =item foo

 The foo sub

 = cut

 sub foo {}
 sub bar {}

 1;
 __END__</code></pre>

<p>In this example <code>Foo::foo</code> is covered, but <code>Foo::bar</code> is not, so the <code>Foo</code> package is only 50% (0.5) covered</p>

<h2 id="Methods">Methods</h2>

<dl>

<dt id="Pod::Coverage-&gt;new(package-=&gt;-$package)"><a id="Pod"></a><a id="Pod::Coverage--new-package----package"></a>Pod::Coverage-&gt;new(package =&gt; $package)</dt>
<dd>

<p>Creates a new Pod::Coverage object.</p>

<p><code>package</code> the name of the package to analyse</p>

<p><code>private</code> an array of regexen which define what symbols are regarded as private (and so need not be documented) defaults to [ qr/^_/, qr/^(un)?import$/, qr/^DESTROY$/, qr/^AUTOLOAD$/, qr/^bootstrap$/, qr/^(TIE( SCALAR | ARRAY | HASH | HANDLE ) | FETCH | STORE | UNTIE | FETCHSIZE | STORESIZE | POP | PUSH | SHIFT | UNSHIFT | SPLICE | DELETE | EXISTS | EXTEND | CLEAR | FIRSTKEY | NEXTKEY | PRINT | PRINTF | WRITE | READLINE | GETC | READ | CLOSE | BINMODE | OPEN | EOF | FILENO | SEEK | TELL | SCALAR )$/x, qr/^( MODIFY | FETCH )_( REF | SCALAR | ARRAY | HASH | CODE | GLOB | FORMAT | IO )_ATTRIBUTES$/x, qr/^CLONE(_SKIP)?$/, ]</p>

<p>This should cover all the usual magical methods for tie()d objects, attributes, generally all the methods that are typically not called by a user, but instead being used internally by perl.</p>

<p><code>also_private</code> items are appended to the private list</p>

<p><code>trustme</code> an array of regexen which define what symbols you just want us to assume are properly documented even if we can&#39;t find any docs for them</p>

<p>If <code>pod_from</code> is supplied, that file is parsed for the documentation, rather than using Pod::Find</p>

<p>If <code>nonwhitespace</code> is supplied, then only POD sections which have non-whitespace characters will count towards being documented.</p>

</dd>
<dt id="$object-&gt;coverage"><a id="object--coverage"></a>$object-&gt;coverage</dt>
<dd>

<p>Gives the coverage as a value in the range 0 to 1</p>

</dd>
<dt id="$object-&gt;why_unrated"><a id="object--why_unrated"></a>$object-&gt;why_unrated</dt>
<dd>

<p><code>$object-&gt;coverage</code> may return <code>undef</code>, to indicate that it was unable to deduce coverage for a package. If this happens you should be able to check <code>why_unrated</code> to get a useful excuse.</p>

</dd>
<dt id="$object-&gt;naked/$object-&gt;uncovered"><a id="object--naked-object--uncovered"></a>$object-&gt;naked/$object-&gt;uncovered</dt>
<dd>

<p>Returns a list of uncovered routines, will implicitly call coverage if it&#39;s not already been called.</p>

<p>Note, private and &#39;trustme&#39; identifiers will be skipped.</p>

</dd>
<dt id="$object-&gt;covered"><a id="object--covered"></a>$object-&gt;covered</dt>
<dd>

<p>Returns a list of covered routines, will implicitly call coverage if it&#39;s not previously been called.</p>

<p>As with <code>naked</code>, private and &#39;trustme&#39; identifiers will be skipped.</p>

</dd>
</dl>

<h2 id="Debugging-support"><a id="Debugging"></a>Debugging support</h2>

<p>In order to allow internals debugging, while allowing the optimiser to do its thang, <code>Pod::Coverage</code> uses constant subs to define how it traces.</p>

<p>Use them like so</p>

<pre><code> sub Pod::Coverage::TRACE_ALL () { 1 }
 use Pod::Coverage;</code></pre>

<p>Supported constants are:</p>

<dl>

<dt id="TRACE_ALL">TRACE_ALL</dt>
<dd>

<p>Trace everything.</p>

<p>Well that&#39;s all there is so far, are you glad you came?</p>

</dd>
</dl>

<h2 id="Inheritance-interface"><a id="Inheritance"></a>Inheritance interface</h2>

<p>These abstract methods while functional in <code>Pod::Coverage</code> may make your life easier if you want to extend <code>Pod::Coverage</code> to fit your house style more closely.</p>

<p><b>NOTE</b> Please consider this interface as in a state of flux until this comment goes away.</p>

<dl>

<dt id="$object-&gt;_CvGV($symbol)"><a id="object--_CvGV-symbol"></a>$object-&gt;_CvGV($symbol)</dt>
<dd>

<p>Return the GV for the coderef supplied. Used by <code>_get_syms</code> to identify locally defined code.</p>

<p>You probably won&#39;t need to override this one.</p>

</dd>
<dt id="$object-&gt;_get_syms($package)"><a id="object--_get_syms-package"></a>$object-&gt;_get_syms($package)</dt>
<dd>

<p>return a list of symbols to check for from the specified packahe</p>

</dd>
<dt id="_get_pods"><a id="get_pods"></a>_get_pods</dt>
<dd>

<p>Extract pod markers from the currently active package.</p>

<p>Return an arrayref or undef on fail.</p>

</dd>
<dt id="_private_check($symbol)"><a id="_private_check"></a><a id="private_check-symbol"></a>_private_check($symbol)</dt>
<dd>

<p>return true if the symbol should be considered private</p>

</dd>
<dt id="_trustme_check($symbol)"><a id="_trustme_check"></a><a id="trustme_check-symbol"></a>_trustme_check($symbol)</dt>
<dd>

<p>return true if the symbol is a &#39;trustme&#39; symbol</p>

</dd>
</dl>

<h1 id="BUGS">BUGS</h1>

<p>Due to the method used to identify documented subroutines <code>Pod::Coverage</code> may completely miss your house style and declare your code undocumented. Patches and/or failing tests welcome.</p>

<h1 id="TODO">TODO</h1>

<dl>

<dt id="Widen-the-rules-for-identifying-documentation"><a id="Widen"></a>Widen the rules for identifying documentation</dt>
<dd>

</dd>
<dt id="Improve-the-code-coverage-of-the-test-suite.-Devel::Cover-rocks-so-hard."><a id="Improve"></a><a id="Improve-the-code-coverage-of-the-test-suite.-Devel::Cover-rocks-so-hard"></a>Improve the code coverage of the test suite. <code>Devel::Cover</code> rocks so hard.</dt>
<dd>

</dd>
</dl>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="https://metacpan.org/pod/Test::More">Test::More</a>, <a href="./Devel::Cover.html">Devel::Cover</a></p>

<h1 id="AUTHORS">AUTHORS</h1>

<p>Richard Clamp &lt;richardc@unixbeard.net&gt;</p>

<p>Michael Stevens &lt;mstevens@etla.org&gt;</p>

<p>some contributions from David Cantrell &lt;david@cantrell.org.uk&gt;</p>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

<p>Copyright (c) 2001, 2003, 2004, 2006, 2007, 2009 Richard Clamp, Michael Stevens. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Pod::Coverage, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Pod::Coverage</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Pod::Coverage</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Pod::Coverage.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
